InfoMagic Internet Tools 1993 July/Internet Tools.iso/RockRidge/mail/pine/imap-3.0/ANSI/c-client/mmdf.h

C/C++ Source or Header | 1993-07-11 | 12.6 KB | 272 lines

/*
 * Program:    MMDF mail routines
 *
 * Author:    Bruce W. Knipe <[e-mail]> from bezerk.c by:
 *        Mark Crispin
 *        Networks and Distributed Computing
 *        Computing & Communications
 *        University of Washington
 *        Administration Building, AG-44
 *        Seattle, WA  98195
 *        Internet: [e-mail]
 *
 * Date:    15 May 1993
 * Last Edited:    11 July 1993
 *
 * Copyright 1993 by the University of Washington
 *
 *  Permission to use, copy, modify, and distribute this software and its
 * documentation for any purpose and without fee is hereby granted, provided
 * that the above copyright notice appears in all copies and that both the
 * above copyright notice and this permission notice appear in supporting
 * documentation, and that the name of the University of Washington not be
 * used in advertising or publicity pertaining to distribution of the software
 * without specific, written prior permission.  This software is made
 * available "as is", and
 * THE UNIVERSITY OF WASHINGTON DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED,
 * WITH REGARD TO THIS SOFTWARE, INCLUDING WITHOUT LIMITATION ALL IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, AND IN
 * NO EVENT SHALL THE UNIVERSITY OF WASHINGTON BE LIABLE FOR ANY SPECIAL,
 * INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, TORT
 * (INCLUDING NEGLIGENCE) OR STRICT LIABILITY, ARISING OUT OF OR IN CONNECTION
 * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *
 */

/* Validate line known to start with ``^A''
 * Accepts: pointer to candidate string to validate as a From header
 *        return pointer to end of date/time field
 *        return pointer to offset from t of time (hours of ``mmm dd hh:mm'')
 *        return pointer to offset from t of time zone (if non-zero)
 * Returns: T if valid From string, t,ti,zn set; else NIL
 */

#define VALID(s,x,ti,zn) \
(s[1] == (char)0x01) && (s[2] == (char)0x01) && (s[3] == (char)0x01) && \
(s[4] == '\n') && (s[5] == 'F' ) && \
(s[6] == 'r' ) && (s[7] == 'o' ) && (s[8] == 'm' ) && (s[9] == ' ')  && \
  (x = strchr (s+10,'\n')) && \
  ((x-s < 46) || ((ti = ((x[-2] == ' ') ? -14 : (x[-3] == ' ') ? -15 : \
             (x[-4] == ' ') ? -16 : (x[-5] == ' ') ? -17 : \
             (x[-6] == ' ') ? -18 : (x[-7] == ' ') ? -19 : \
             (x[-8] == ' ') ? -20 : (x[-9] == ' ') ? -21 : \
             (x[-10]== ' ') ? -22 : (x[-11]== ' ') ? -23 : 0)) && \
          (x[ti]   == ' ') && (x[ti+1] == 'r') && (x[ti+2] == 'e') && \
          (x[ti+3] == 'm') && (x[ti+4] == 'o') && (x[ti+5] == 't') && \
          (x[ti+6] == 'e') && (x[ti+7] == ' ') && (x[ti+8] == 'f') && \
          (x[ti+9] == 'r') && (x[ti+10]== 'o') && (x[ti+11]== 'm') && \
          (x += ti)) || T) && \
  (x-s >= 27) && \
  ((x[ti = -5] == ' ') ? ((x[-8] == ':') ? !(zn = 0) : \
              ((x[ti = zn = -9] == ' ') || \
               ((x[ti = zn = -11] == ' ') && \
                ((x[-10] == '+') || (x[-10] == '-'))))) : \
   ((x[zn = -4] == ' ') ? (x[ti = -9] == ' ') : \
    ((x[zn = -6] == ' ') && ((x[-5] == '+') || (x[-5] == '-')) && \
     (x[ti = -11] == ' ')))) && \
  (x[ti - 3] == ':') && (x[ti -= ((x[ti - 6] == ':') ? 9 : 6)] == ' ') && \
  (x[ti - 3] == ' ') && (x[ti - 7] == ' ') && (x[ti - 11] == ' ')


/* You are not expected to understand this macro, but read the next page if
 * you are not faint of heart.
 *
 * Known formats to the VALID macro are:
 *         From user Wed Dec  2 05:53 1992
 * BSD        From user Wed Dec  2 05:53:22 1992
 * SysV        From user Wed Dec  2 05:53 PST 1992
 * rn        From user Wed Dec  2 05:53:22 PST 1992
 *        From user Wed Dec  2 05:53 -0700 1992
 *        From user Wed Dec  2 05:53:22 -0700 1992
 *        From user Wed Dec  2 05:53 1992 PST
 *        From user Wed Dec  2 05:53:22 1992 PST
 *        From user Wed Dec  2 05:53 1992 -0700
 * Solaris    From user Wed Dec  2 05:53:22 1992 -0700
 *
 * Plus all of the above with `` remote from xxx'' after it. Thank you very
 * much, smail and Solaris, for making my life considerably more complicated.
 */

/*
 * What?  You want to understand the VALID macro anyway?  Alright, since you
 * insist.  Actually, it isn't really all that difficult, provided that you
 * take it step by step.
 *
 * Line 1    Validates that the 2-4th characters are CTRL/A.
 * Line 2    Validates that the 5-6th characters are newline and ``F''.
 * Line 3    Validates that the 7-10th characters are ``rom ''.
 * Line 4    Sets x to point to the end of the line.
 * Lines 5-14    First checks to see if the line is at least 46 characters long.
 *        If so, it scans backwards up to 10 characters (the UUCP system
 *        name length limit due to old versions of UNIX) to find a space.
 *        If one is found, it backs up 12 characters from that point, and
 *        sees if the string from there is `` remote from''.  If so, it
 *        sets x to that position.  The ``|| T'' is there so the parse
 *        will still continue.
 * Line 15    Makes sure that there are at least 27 characters in the line.
 * Lines 16-19    Checks if the date/time ends with the year.  If so, It sees if
 *        there is a colon 3 characters further back; this would mean
 *        that there is no timezone field and zn is set to 0 and ti is
 *        left in front of the year.  If not, then it expects there to
 *        either to be a space four characters back for a three-letter
 *        timezone, or a space six characters back followed by a + or -
 *        for a numeric timezone.  If a timezone is found, both zn and
 *        ti are the offset of the space immediately before it.
 * Lines 20-22    Are the failure case for a date/time not ending with a year in
 *        line 14.  If there is a space four characters back, it is a
 *        three-letter timezone; there must be a space for the year nine
 *        characters back.  Otherwise, there must be a space six
 *        characters back and a + or - five characters back to indicate a
 *        numeric timezone and a space eleven characters back to indicate
 *        a year.  zn and ti are set appropriately.
 * Line 23    Make sure that the string before ti is of the form hh:mm or
 *        hh:mm:ss.  There must be a colon three characters back, and a
 *        space six or nine characters back (depending upon whether or
 *        not the character six characters back is a colon).  ti is set
 *        to be the offset of the space immediately before the time.
 * Line 24    Make sure the string before ti is of the form www mmm dd.
 *        There must be a space three characters back (in front of the
 *        day), one seven characters back (in front of the month), and
 *        one eleven characters back (in front of the day of week).
 *
 * Why a macro?  It gets invoked a *lot* in a tight loop.  On some of the
 * newer pipelined machines it is faster being open-coded than it would be if
 * subroutines are called.
 *
 * Why does it scan backwards from the end of the line, instead of doing the
 * much easier forward scan?  There is no deterministic way to parse the
 * ``user'' field, because it may contain unquoted spaces!  Yes, I tested it to
 * see if unquoted spaces were possible.  They are, and I've encountered enough
 * evil mail to be totally unwilling to trust that ``it will never happen''.
 */

/* Build parameters */

#define KODRETRY 15        /* kiss-of-death retry in seconds */
#define LOCKTIMEOUT 5        /* lock timeout in minutes */
#define CHUNK 8192        /* read-in chunk size */


/* Command bits from mmdf_getflags() */

#define fSEEN 1
#define fDELETED 2
#define fFLAGGED 4
#define fANSWERED 8


/* Status string */

#define STATUS "Status: RO\nX-Status: DFA\n\n"

/* MMDF per-message cache information */

typedef struct file_cache {
  char *header;            /* pointer to RFC 822 header */
  unsigned long headersize;    /* size of RFC 822 header */
  char *body;            /* pointer to message body */
  unsigned long bodysize;    /* size of message body */
  char status[sizeof (STATUS)];    /* status flags */
  char internal[1];        /* start of internal header and data */
} FILECACHE;


/* MMDF I/O stream local data */

typedef struct mmdf_local {
  unsigned int dirty : 1;    /* disk copy needs updating */
  int ld;            /* lock file descriptor */
  char *name;            /* local file name for recycle case */
  char *lname;            /* lock file name */
  off_t filesize;        /* file size parsed */
  time_t filetime;        /* last file time */
  unsigned long cachesize;    /* size of local cache */
  FILECACHE **msgs;        /* pointers to message-specific information */
  char *buf;            /* temporary buffer */
  unsigned long buflen;        /* current size of temporary buffer */
} MMDFLOCAL;


/* Convenient access to local data */

#define LOCAL ((MMDFLOCAL *) stream->local)

/* Function prototypes */

DRIVER *mmdf_valid (char *name);
int mmdf_isvalid (char *name,char *tmp);
void *mmdf_parameters (long function,void *value);
void mmdf_find (MAILSTREAM *stream,char *pat);
void mmdf_find_bboards (MAILSTREAM *stream,char *pat);
void mmdf_find_all (MAILSTREAM *stream,char *pat);
void mmdf_find_all_bboards (MAILSTREAM *stream,char *pat);
long mmdf_subscribe (MAILSTREAM *stream,char *mailbox);
long mmdf_unsubscribe (MAILSTREAM *stream,char *mailbox);
long mmdf_subscribe_bboard (MAILSTREAM *stream,char *mailbox);
long mmdf_unsubscribe_bboard (MAILSTREAM *stream,char *mailbox);
long mmdf_create (MAILSTREAM *stream,char *mailbox);
long mmdf_delete (MAILSTREAM *stream,char *mailbox);
long mmdf_rename (MAILSTREAM *stream,char *old,char *new);
MAILSTREAM *mmdf_open (MAILSTREAM *stream);
void mmdf_close (MAILSTREAM *stream);
void mmdf_fetchfast (MAILSTREAM *stream,char *sequence);
void mmdf_fetchflags (MAILSTREAM *stream,char *sequence);
ENVELOPE *mmdf_fetchstructure (MAILSTREAM *stream,long msgno,BODY **body);
char *bezerk_snarf (MAILSTREAM *stream,long msgno,long *size);
char *mmdf_fetchheader (MAILSTREAM *stream,long msgno);
char *mmdf_fetchtext (MAILSTREAM *stream,long msgno);
char *mmdf_fetchbody(MAILSTREAM *stream,long m,char *sec,unsigned long *len);
void mmdf_setflag (MAILSTREAM *stream,char *sequence,char *flag);
void mmdf_clearflag (MAILSTREAM *stream,char *sequence,char *flag);
void mmdf_search (MAILSTREAM *stream,char *criteria);
long mmdf_ping (MAILSTREAM *stream);
void mmdf_check (MAILSTREAM *stream);
void mmdf_expunge (MAILSTREAM *stream);
long mmdf_copy (MAILSTREAM *stream,char *sequence,char *mailbox);
long mmdf_move (MAILSTREAM *stream,char *sequence,char *mailbox);
long mmdf_append (MAILSTREAM *stream,char *mailbox,STRING *message);
void mmdf_gc (MAILSTREAM *stream,long gcflags);

void mmdf_abort (MAILSTREAM *stream);
char *mmdf_file (char *dst,char *name);
int mmdf_lock (char *file,int flags,int mode,char *lock,int op);
void mmdf_unlock (int fd,MAILSTREAM *stream,char *lock);
int mmdf_parse (MAILSTREAM *stream,char *lock,int op);
char *mmdf_eom (char *som,char *sod,long i);
int mmdf_extend (MAILSTREAM *stream,int fd,char *error);
void mmdf_save (MAILSTREAM *stream,int fd);
int mmdf_copy_messages (MAILSTREAM *stream,char *mailbox);
void mmdf_write_message (struct iovec iov[],int *i,FILECACHE *m);
void mmdf_update_status (char *status,MESSAGECACHE *elt);
short mmdf_getflags (MAILSTREAM *stream,char *flag);
char mmdf_search_all (MAILSTREAM *stream,long msgno,char *d,long n);
char mmdf_search_answered (MAILSTREAM *stream,long msgno,char *d,long n);
char mmdf_search_deleted (MAILSTREAM *stream,long msgno,char *d,long n);
char mmdf_search_flagged (MAILSTREAM *stream,long msgno,char *d,long n);
char mmdf_search_keyword (MAILSTREAM *stream,long msgno,char *d,long n);
char mmdf_search_new (MAILSTREAM *stream,long msgno,char *d,long n);
char mmdf_search_old (MAILSTREAM *stream,long msgno,char *d,long n);
char mmdf_search_recent (MAILSTREAM *stream,long msgno,char *d,long n);
char mmdf_search_seen (MAILSTREAM *stream,long msgno,char *d,long n);
char mmdf_search_unanswered (MAILSTREAM *stream,long msgno,char *d,long n);
char mmdf_search_undeleted (MAILSTREAM *stream,long msgno,char *d,long n);
char mmdf_search_unflagged (MAILSTREAM *stream,long msgno,char *d,long n);
char mmdf_search_unkeyword (MAILSTREAM *stream,long msgno,char *d,long n);
char mmdf_search_unseen (MAILSTREAM *stream,long msgno,char *d,long n);
char mmdf_search_before (MAILSTREAM *stream,long msgno,char *d,long n);
char mmdf_search_on (MAILSTREAM *stream,long msgno,char *d,long n);
char mmdf_search_since (MAILSTREAM *stream,long msgno,char *d,long n);
char mmdf_search_body (MAILSTREAM *stream,long msgno,char *d,long n);
char mmdf_search_subject (MAILSTREAM *stream,long msgno,char *d,long n);
char mmdf_search_text (MAILSTREAM *stream,long msgno,char *d,long n);
char mmdf_search_bcc (MAILSTREAM *stream,long msgno,char *d,long n);
char mmdf_search_cc (MAILSTREAM *stream,long msgno,char *d,long n);
char mmdf_search_from (MAILSTREAM *stream,long msgno,char *d,long n);
char mmdf_search_to (MAILSTREAM *stream,long msgno,char *d,long n);

typedef char (*search_t) (MAILSTREAM *stream,long msgno,char *d,long n);
search_t mmdf_search_date (search_t f,long *n);
search_t mmdf_search_flag (search_t f,char **d);
search_t mmdf_search_string (search_t f,char **d,long *n);